<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkToolShell</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkTearoffMenuItem.html" title="GtkTearoffMenuItem">
<link rel="next" href="GtkToolbar.html" title="GtkToolbar">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="Builder.html" title="Interface builder">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="api-index-full.html" title="Index of all symbols">
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
<link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
<link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
<link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
<link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
<link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkTearoffMenuItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MenusAndCombos.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkToolbar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkToolShell.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#GtkToolShell.description" class="shortcut">Description</a>
                 | 
                <a href="#GtkToolShell.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#GtkToolShell.prerequisites" class="shortcut">Prerequisites</a>
                 | 
                <a href="#GtkToolShell.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkToolShell"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkToolShell.top_of_page"></a>GtkToolShell</span></h2>
<p>GtkToolShell — Interface for containers containing <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> widgets.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkToolShell.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gtk/gtk.h&gt;

                    <a class="link" href="GtkToolShell.html#GtkToolShell-struct" title="GtkToolShell">GtkToolShell</a>;
                    <a class="link" href="GtkToolShell.html#GtkToolShellIface" title="GtkToolShellIface">GtkToolShellIface</a>;
<a class="link" href="gtk-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize">GtkIconSize</a>         <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-icon-size" title="gtk_tool_shell_get_icon_size ()">gtk_tool_shell_get_icon_size</a>        (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);
<a class="link" href="gtk-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation">GtkOrientation</a>      <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-orientation" title="gtk_tool_shell_get_orientation ()">gtk_tool_shell_get_orientation</a>      (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);
<a class="link" href="gtk-Standard-Enumerations.html#GtkReliefStyle" title="enum GtkReliefStyle">GtkReliefStyle</a>      <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-relief-style" title="gtk_tool_shell_get_relief_style ()">gtk_tool_shell_get_relief_style</a>     (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);
<a class="link" href="gtk-Standard-Enumerations.html#GtkToolbarStyle" title="enum GtkToolbarStyle">GtkToolbarStyle</a>     <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-style" title="gtk_tool_shell_get_style ()">gtk_tool_shell_get_style</a>            (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);
void                <a class="link" href="GtkToolShell.html#gtk-tool-shell-rebuild-menu" title="gtk_tool_shell_rebuild_menu ()">gtk_tool_shell_rebuild_menu</a>         (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToolShell.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----GtkToolShell
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToolShell.prerequisites"></a><h2>Prerequisites</h2>
<p>
GtkToolShell requires
 <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a> and  <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToolShell.implementations"></a><h2>Known Implementations</h2>
<p>
GtkToolShell is implemented by
 <a class="link" href="GtkToolbar.html" title="GtkToolbar">GtkToolbar</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToolShell.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a> interface allows container widgets to provide additional
information when embedding <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> widgets.
</p>
<p>
<em class="parameter"><code>see_also</code></em>: <a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a>, <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a></p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToolShell.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToolShell-struct"></a><h3>GtkToolShell</h3>
<pre class="programlisting">typedef struct _GtkToolShell GtkToolShell;</pre>
<p>
Dummy structure for accessing instances of <a class="link" href="GtkToolShell.html#GtkToolShellIface" title="GtkToolShellIface"><span class="type">GtkToolShellIface</span></a>.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkToolShellIface"></a><h3>GtkToolShellIface</h3>
<pre class="programlisting">typedef struct {
  GtkIconSize     (*get_icon_size)    (GtkToolShell *shell);
  GtkOrientation  (*get_orientation)  (GtkToolShell *shell);
  GtkToolbarStyle (*get_style)        (GtkToolShell *shell);
  GtkReliefStyle  (*get_relief_style) (GtkToolShell *shell);
  void            (*rebuild_menu)     (GtkToolShell *shell);
} GtkToolShellIface;
</pre>
<p>
Virtual function table for the <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a> interface.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code>get_icon_size</code></em> ()</span></p></td>
<td>    mandatory implementation of <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-icon-size" title="gtk_tool_shell_get_icon_size ()"><code class="function">gtk_tool_shell_get_icon_size()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>get_orientation</code></em> ()</span></p></td>
<td>  mandatory implementation of <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-orientation" title="gtk_tool_shell_get_orientation ()"><code class="function">gtk_tool_shell_get_orientation()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>get_style</code></em> ()</span></p></td>
<td>        mandatory implementation of <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-style" title="gtk_tool_shell_get_style ()"><code class="function">gtk_tool_shell_get_style()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>get_relief_style</code></em> ()</span></p></td>
<td> optional implementation of <a class="link" href="GtkToolShell.html#gtk-tool-shell-get-relief-style" title="gtk_tool_shell_get_relief_style ()"><code class="function">gtk_tool_shell_get_relief_style()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code>rebuild_menu</code></em> ()</span></p></td>
<td>     optional implementation of <a class="link" href="GtkToolShell.html#gtk-tool-shell-rebuild-menu" title="gtk_tool_shell_rebuild_menu ()"><code class="function">gtk_tool_shell_rebuild_menu()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-tool-shell-get-icon-size"></a><h3>gtk_tool_shell_get_icon_size ()</h3>
<pre class="programlisting"><a class="link" href="gtk-Themeable-Stock-Images.html#GtkIconSize" title="enum GtkIconSize">GtkIconSize</a>         gtk_tool_shell_get_icon_size        (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);</pre>
<p>
Retrieves the icon size for the tool shell. Tool items must not call this
function directly, but rely on <a class="link" href="GtkToolItem.html#gtk-tool-item-get-icon-size" title="gtk_tool_item_get_icon_size ()"><code class="function">gtk_tool_item_get_icon_size()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the current size for icons of <em class="parameter"><code>shell</code></em>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-tool-shell-get-orientation"></a><h3>gtk_tool_shell_get_orientation ()</h3>
<pre class="programlisting"><a class="link" href="gtk-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation">GtkOrientation</a>      gtk_tool_shell_get_orientation      (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);</pre>
<p>
Retrieves the current orientation for the tool shell. Tool items must not
call this function directly, but rely on <a class="link" href="GtkToolItem.html#gtk-tool-item-get-orientation" title="gtk_tool_item_get_orientation ()"><code class="function">gtk_tool_item_get_orientation()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the current orientation of <em class="parameter"><code>shell</code></em>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-tool-shell-get-relief-style"></a><h3>gtk_tool_shell_get_relief_style ()</h3>
<pre class="programlisting"><a class="link" href="gtk-Standard-Enumerations.html#GtkReliefStyle" title="enum GtkReliefStyle">GtkReliefStyle</a>      gtk_tool_shell_get_relief_style     (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);</pre>
<p>
Returns the relief style of buttons on <em class="parameter"><code>shell</code></em>. Tool items must not call this
function directly, but rely on <a class="link" href="GtkToolItem.html#gtk-tool-item-get-relief-style" title="gtk_tool_item_get_relief_style ()"><code class="function">gtk_tool_item_get_relief_style()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The relief style of buttons on <em class="parameter"><code>shell</code></em>.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-tool-shell-get-style"></a><h3>gtk_tool_shell_get_style ()</h3>
<pre class="programlisting"><a class="link" href="gtk-Standard-Enumerations.html#GtkToolbarStyle" title="enum GtkToolbarStyle">GtkToolbarStyle</a>     gtk_tool_shell_get_style            (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);</pre>
<p>
Retrieves whether the tool shell has text, icons, or both. Tool items must
not call this function directly, but rely on <code class="function">gtk_tool_item_get_style()</code>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the current style of <em class="parameter"><code>shell</code></em>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-tool-shell-rebuild-menu"></a><h3>gtk_tool_shell_rebuild_menu ()</h3>
<pre class="programlisting">void                gtk_tool_shell_rebuild_menu         (<a class="link" href="GtkToolShell.html" title="GtkToolShell">GtkToolShell</a> *shell);</pre>
<p>
Calling this function signals the tool shell that the overflow menu item for
tool items have changed. If there is an overflow menu and if it is visible
when this function it called, the menu will be rebuilt.
</p>
<p>
Tool items must not call this function directly, but rely on
<a class="link" href="GtkToolItem.html#gtk-tool-item-rebuild-menu" title="gtk_tool_item_rebuild_menu ()"><code class="function">gtk_tool_item_rebuild_menu()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToolShell.html" title="GtkToolShell"><span class="type">GtkToolShell</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>
